Make documentation and examples more prominent in README #26498
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There's a lot more documentation to this library than many users would see looking at the current README - Make a dedicated 'Documentation and examples' heading - Bring the Solana Cookbook (which has more examples than all the other documentation listed in the README) to the top - Mention the examples higher up in the README
jstarry
reviewed
Jul 8, 2022
mikemaccana
commented
Jul 8, 2022
mikemaccana
commented
Jul 8, 2022
Codecov Report
@@ Coverage Diff @@
## master #26498 +/- ##
===========================================
- Coverage 81.9% 76.0% -5.9%
===========================================
Files 631 40 -591
Lines 174252 2370 -171882
Branches 0 343 +343
===========================================
- Hits 142728 1803 -140925
+ Misses 31524 449 -31075
- Partials 0 118 +118 |
jeffwashington
pushed a commit
to jeffwashington/solana
that referenced
this pull request
Jul 10, 2022
…na-labs#26498) * Make documentation and examples more prominent in README There's a lot more documentation to this library than many users would see looking at the current README - Make a dedicated 'Documentation and examples' heading - Bring the Solana Cookbook (which has more examples than all the other documentation listed in the README) to the top - Mention the examples higher up in the README * Update web3.js/README.md * Update web3.js/README.md
This was referenced Aug 3, 2022
This was referenced Aug 6, 2022
This was referenced Aug 19, 2022
This was referenced Aug 26, 2022
This was referenced Sep 10, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem
There's a lot more documentation to this library than many users would see looking at the current README
Summary of Changes